Developer CD Series 1995 June: Reference Library

home *** CD-ROM | disk | FTP | other *** search

/ Developer CD Series 1995 June: Reference Library / Dev.CD Jun 95 / Dev.CD Jun 95.toast / What's New? / Sample Code / MoreFiles 1.3 / MoreFilesExtras.h < prev next >

Wrap

C/C++ Source or Header | 1995-04-18 | 55.3 KB | 1,581 lines | [TEXT/MMCC]

/* ** Apple Macintosh Developer Technical Support ** ** A collection of useful high-level File Manager routines. ** ** by Jim Luther, Apple Developer Technical Support ** ** File: MoreFilesExtras.h ** ** Copyright © 1992-1995 Apple Computer, Inc. ** All rights reserved. ** ** You may incorporate this sample code into your applications without ** restriction, though the sample code has been provided "AS IS" and the ** responsibility for its operation is 100% yours. However, what you are ** not permitted to do is to redistribute the source as "DSC Sample Code" ** after having made changes. If you're going to re-distribute the source, ** we require that you make it clear in the source that the code was ** descended from Apple Sample Code, but that you've made changes. */ #ifndef __MOREFILESEXTRAS__ #define __MOREFILESEXTRAS__ #include <Types.h> #include <Files.h> /*****************************************************************************/ /* ** Macros to get information out of GetVolParmsInfoBuffer */ #define isNetworkVolume(volParms) ((volParms).vMServerAdr != 0) #define hasLimitFCBs(volParms) (((volParms).vMAttrib & (1L << bLimitFCBs)) != 0) #define hasLocalWList(volParms) (((volParms).vMAttrib & (1L << bLocalWList)) != 0) #define hasNoMiniFndr(volParms) (((volParms).vMAttrib & (1L << bNoMiniFndr)) != 0) #define hasNoVNEdit(volParms) (((volParms).vMAttrib & (1L << bNoVNEdit)) != 0) #define hasNoLclSync(volParms) (((volParms).vMAttrib & (1L << bNoLclSync)) != 0) #define hasTrshOffLine(volParms) (((volParms).vMAttrib & (1L << bTrshOffLine)) != 0) #define hasNoSwitchTo(volParms) (((volParms).vMAttrib & (1L << bNoSwitchTo)) != 0) #define hasNoDeskItems(volParms) (((volParms).vMAttrib & (1L << bNoDeskItems)) != 0) #define hasNoBootBlks(volParms) (((volParms).vMAttrib & (1L << bNoBootBlks)) != 0) #define hasAccessCntl(volParms) (((volParms).vMAttrib & (1L << bAccessCntl)) != 0) #define hasNoSysDir(volParms) (((volParms).vMAttrib & (1L << bNoSysDir)) != 0) #define hasExtFSVol(volParms) (((volParms).vMAttrib & (1L << bHasExtFSVol)) != 0) #define hasOpenDeny(volParms) (((volParms).vMAttrib & (1L << bHasOpenDeny)) != 0) #define hasCopyFile(volParms) (((volParms).vMAttrib & (1L << bHasCopyFile)) != 0) #define hasMoveRename(volParms) (((volParms).vMAttrib & (1L << bHasMoveRename)) != 0) #define hasDesktopMgr(volParms) (((volParms).vMAttrib & (1L << bHasDesktopMgr)) != 0) #define hasShortName(volParms) (((volParms).vMAttrib & (1L << bHasShortName)) != 0) #define hasFolderLock(volParms) (((volParms).vMAttrib & (1L << bHasFolderLock)) != 0) #define hasPersonalAccessPrivileges(volParms) \ (((volParms).vMAttrib & (1L << bHasPersonalAccessPrivileges)) != 0) #define hasUserGroupList(volParms) (((volParms).vMAttrib & (1L << bHasUserGroupList)) != 0) #define hasCatSearch(volParms) (((volParms).vMAttrib & (1L << bHasCatSearch)) != 0) #define hasFileIDs(volParms) (((volParms).vMAttrib & (1L << bHasFileIDs)) != 0) #define hasBTreeMgr(volParms) (((volParms).vMAttrib & (1L << bHasBTreeMgr)) != 0) #define hasBlankAccessPrivileges(volParms) \ (((volParms).vMAttrib & (1L << bHasBlankAccessPrivileges)) != 0) /*****************************************************************************/ /* ** Deny mode permissions for use with the HOpenAware, HOpenRFAware, ** FSpOpenAware, and FSpOpenRFAware functions. */ enum { dmNone = 0x0000, dmNoneDenyRd = 0x0010, dmNoneDenyWr = 0x0020, dmNoneDenyRdWr = 0x0030, dmRd = 0x0001, /* Single writer, multiple readers; the readers */ dmRdDenyRd = 0x0011, dmRdDenyWr = 0x0021, /* Browsing - equivalent to fsRdPerm */ dmRdDenyRdWr = 0x0031, dmWr = 0x0002, dmWrDenyRd = 0x0012, dmWrDenyWr = 0x0022, dmWrDenyRdWr = 0x0032, dmRdWr = 0x0003, /* Shared access - equivalent to fsRdWrShPerm */ dmRdWrDenyRd = 0x0013, dmRdWrDenyWr = 0x0023, /* Single writer, multiple readers; the writer */ dmRdWrDenyRdWr = 0x0033 /* Exclusive access - equivalent to fsRdWrPerm */ }; /*****************************************************************************/ /* ** For those times where you need to use more than one kind of File Manager parameter ** block but don't feel like wasting stack space, here's a parameter block you can reuse. */ #if GENERATINGPOWERPC #pragma options align=mac68k #endif union UniversalFMPB { ParamBlockRec PB; CInfoPBRec ciPB; DTPBRec dtPB; HParamBlockRec hPB; CMovePBRec cmPB; WDPBRec wdPB; FCBPBRec fcbPB; }; #if GENERATINGPOWERPC #pragma options align=reset #endif typedef union UniversalFMPB UniversalFMPB; typedef UniversalFMPB *UniversalFMPBPtr, **UniversalFMPBHandle; /* ** Used by GetUGEntries to return user or group lists */ #if GENERATINGPOWERPC #pragma options align=mac68k #endif struct UGEntry { short objType; /* object type: -1 = group; 0 = user */ long objID; /* the user or group ID */ Str31 name; /* the user or group name */ }; #if GENERATINGPOWERPC #pragma options align=reset #endif typedef struct UGEntry UGEntry; typedef UGEntry *UGEntryPtr, **UGEntryHandle; typedef unsigned char Str8[9]; /* ** I use the following record instead of the AFPVolMountInfo structure in Files.h */ #if GENERATINGPOWERPC #pragma options align=mac68k #endif struct MyAFPVolMountInfo { short length; /* length of this record */ VolumeType media; /* type of media, always AppleShareMediaType */ short flags; /* 0 = normal mount; set bit 0 to inhibit greeting messages */ char nbpInterval; /* NBP interval parameter; 7 is a good choice */ char nbpCount; /* NBP count parameter; 5 is a good choice */ short uamType; /* User Authentication Method */ short zoneNameOffset; /* offset from start of record to zoneName */ short serverNameOffset; /* offset from start of record to serverName */ short volNameOffset; /* offset from start of record to volName */ short userNameOffset; /* offset from start of record to userName */ short userPasswordOffset; /* offset from start of record to userPassword */ short volPasswordOffset; /* offset from start of record to volPassword */ Str31 zoneName; /* server's AppleTalk zone name */ Str31 serverName; /* server name */ Str27 volName; /* volume name */ Str31 userName; /* user name (zero length Pascal string for guest) */ Str8 userPassword; /* user password (zero length Pascal string if no user password) */ char filler1; /* to word align volPassword */ Str8 volPassword; /* volume password (zero length Pascal string if no volume password) */ char filler2; /* to end record on word boundry */ }; #if GENERATINGPOWERPC #pragma options align=reset #endif typedef struct MyAFPVolMountInfo MyAFPVolMountInfo; typedef MyAFPVolMountInfo *MyAFPVolMountInfoPtr, **MyAFPVolMountInfoHandle; /*****************************************************************************/ pascal Ptr GetTempBuffer(long buffReqSize, long *buffActSize); /* ¶ Allocate a temporary copy or search buffer. The GetTempBuffer function allocates a temporary buffer for file system operations which is at least 1024 bytes (1K) and a multiple of 1024 bytes. buffReqSize input: Size you'd like the buffer to be. buffActSize output: Size of buffer allocated. function result output: Pointer to memory allocated or nil if no memory was available. The caller is responsible for disposing of this buffer with DisposePtr. */ /*****************************************************************************/ pascal OSErr DetermineVRefNum(StringPtr pathname, short vRefNum, short *realVRefNum); /* ¶ Determine the real volume reference number. The DetermineVRefNum function determines the volume reference number of a volume from a pathname, a volume specification, or a combination of the two. WARNING: Volume names on the Macintosh are *not* unique -- Multiple mounted volumes can have the same name. For this reason, the use of a volume name or full pathname to identify a specific volume may not produce the results you expect. If more than one volume has the same name and a volume name or full pathname is used, the File Manager currently uses the first volume it finds with a matching name in the volume queue. pathName input: Pointer to a full pathname or nil. If you pass in a partial pathname, it is ignored. A full pathname to a volume must end with a colon character (:). vRefNum input: Volume specification (volume reference number, working directory number, drive number, or 0). realVRefNum output: The real volume reference number. */ /*****************************************************************************/ pascal OSErr HGetVInfo(short volReference, StringPtr volName, short *vRefNum, unsigned long *freeBytes, unsigned long *totalBytes); /* ¶ Get information about a mounted volume. The HGetVInfo function returns the name, volume reference number, available space (in bytes), and total space (in bytes) for the specified volume. You can specify the volume by providing its drive number, volume reference number, or 0 for the default volume. This routine is compatible with volumes up to 4 gigabytes. volReference input: The drive number, volume reference number, or 0 for the default volume. volName input: A pointer to a buffer (minimum Str27) where the volume name is to be returned or must be nil. output: The volume name. vRefNum output: The volume reference number. freeBytes output: The number of free bytes on the volume. freeBytes is an unsigned long value. totalBytes output: The total number of bytes on the volume. totalBytes is an unsigned long value. */ /*****************************************************************************/ pascal OSErr CheckVolLock(StringPtr pathname, short vRefNum); /* ¶ Determine if a volume is locked. The CheckVolLock function determines if a volume is locked - either by hardware or by software. If CheckVolLock returns noErr, then the volume is not locked. pathName input: Pointer to a full pathname or nil. If you pass in a partial pathname, it is ignored. A full pathname to a volume must end with a colon character (:). vRefNum input: Volume specification (volume reference number, working directory number, drive number, or 0). */ /*****************************************************************************/ pascal OSErr GetDriverName(short driverRefNum, Str255 driverName); /* ¶ Get a device driver's name. The GetDriverName function returns a device driver's name. driverRefNum input: The driver reference number. driverName output: The driver's name. */ /*****************************************************************************/ pascal OSErr FindDrive(StringPtr pathname, short vRefNum, DrvQElPtr *driveQElementPtr); /* ¶ Find a volume's drive queue element in the drive queue. The FindDrive function returns a pointer to a mounted volume's drive queue element. pathName input: Pointer to a full pathname or nil. If you pass in a partial pathname, it is ignored. A full pathname to a volume must end with a colon character (:). vRefNum input: Volume specification (volume reference number, working directory number, drive number, or 0). driveQElementPtr output: Pointer to a volume's drive queue element in the drive queue. DO NOT change the DrvQEl. */ /*****************************************************************************/ pascal OSErr UnmountAndEject(StringPtr pathname, short vRefNum); /* ¶ Unmount and eject a volume. The UnmountAndEject function unmounts and ejects a volume. The volume is ejected only if it is ejectable and not already ejected. pathName input: Pointer to a full pathname or nil. If you pass in a partial pathname, it is ignored. A full pathname to a volume must end with a colon character (:). vRefNum input: Volume specification (volume reference number, working directory number, drive number, or 0). */ /*****************************************************************************/ pascal OSErr OnLine(FSSpecPtr volumes, short reqVolCount, short *actVolCount, short *volIndex); /* ¶ Return the list of volumes currently mounted. The OnLine function returns the list of volumes currently mounted in an array of FSSpec records. volumes input: Pointer to array of FSSpec where the volume list is returned. reqVolCount input: Maximum number of volumes to return (the number of elements in the volumes array). actVolCount output: The number of volumes actually returned. volIndex input: The current volume index position. Set to 1 to start with the first volume. output: The volume index position to get the next volume. Pass this value the next time you call OnLine to start where you left off. */ /*****************************************************************************/ pascal OSErr GetDInfo(short vRefNum, long dirID, StringPtr name, DInfo *fndrInfo); /* ¶ Get the finder information for a directory. The GetDInfo function gets the finder information for a directory. vRefNum input: Volume specification. dirID input: Directory ID. name input: Pointer to object name, or nil when dirID specifies a directory that's the object. fndrInfo output: If the object is a directory, then its DInfo. __________ Also see: FSpGetDInfo, */ /*****************************************************************************/ pascal OSErr FSpGetDInfo(const FSSpec *spec, DInfo *fndrInfo); /* ¶ Get the finder information for a directory. The FSpGetDInfo function gets the finder information for a directory. spec input: An FSSpec record specifying the directory. fndrInfo output: If the object is a directory, then its DInfo. __________ Also see: FSpGetFInfoCompat, GetDInfo */ /*****************************************************************************/ pascal OSErr SetDInfo(short vRefNum, long dirID, StringPtr name, const DInfo *fndrInfo); /* ¶ Set the finder information for a directory. The SetDInfo function sets the finder information for a directory. vRefNum input: Volume specification. dirID input: Directory ID. name input: Pointer to object name, or nil when dirID specifies a directory that's the object. fndrInfo input: The DInfo. __________ Also see: FSpSetDInfo, */ /*****************************************************************************/ pascal OSErr FSpSetDInfo(const FSSpec *spec, const DInfo *fndrInfo); /* ¶ Set the finder information for a directory. The FSpSetDInfo function sets the finder information for a directory. spec input: An FSSpec record specifying the directory. fndrInfo input: The DInfo. __________ Also see: FSpSetFInfoCompat, SetDInfo */ /*****************************************************************************/ pascal OSErr GetDirID(short vRefNum, long dirID, StringPtr name, long *theDirID, Boolean *isDirectory); /* ¶ Get the directory ID number of the directory specified. The GetDirID function gets the directory ID number of the directory specified. If a file is specified, then the parent directory of the file is returned and isDirectory is false. If a directory is specified, then that directory's ID number is returned and isDirectory is true. WARNING: Volume names on the Macintosh are *not* unique -- Multiple mounted volumes can have the same name. For this reason, the use of a volume name or full pathname to identify a specific volume may not produce the results you expect. If more than one volume has the same name and a volume name or full pathname is used, the File Manager currently uses the first volume it finds with a matching name in the volume queue. vRefNum input: Volume specification. dirID input: Directory ID. name input: Pointer to object name, or nil when dirID specifies a directory that's the object. theDirID output: If the object is a file, then its parent directory ID. If the object is a directory, then its ID. isDirectory output: True if object is a directory; false if object is a file. */ /*****************************************************************************/ pascal OSErr DirIDFromFSSpec(const FSSpec *spec, long *dirID, Boolean *isDirectory); /* ¶ Get the directory ID number of a directory. The DirIDFromFSSpec function gets the directory ID number of the directory specified by spec. If spec is to a file, then the parent directory of the file is returned and isDirectory is false. If spec is to a directory, then that directory's ID number is returned and isDirectory is true. spec input: An FSSpec record specifying the directory. theDirID output: The directory ID. isDirectory output: True if object is a directory; false if object is a file. */ /*****************************************************************************/ pascal OSErr GetDirName(short vRefNum, long dirID, StringPtr name); /* ¶ Get the name of a directory from its directory ID. The GetDirName function gets the name of a directory from its directory ID. vRefNum input: Volume specification. dirID input: Directory ID. name output: Points to a buffer (minimum Str63) where the directory name is to be returned or must be nil. */ /*****************************************************************************/ pascal OSErr GetParentID(short vRefNum, long dirID, StringPtr name, long *parID); /* ¶ Get the parent directory ID number of the specified object. The GetParentID function gets the parent directory ID number of the specified object. vRefNum input: Volume specification. dirID input: Directory ID. name input: Pointer to object name, or nil when dirID specifies a directory that's the object. parID output: The parent directory ID of the specified object. */ /*****************************************************************************/ pascal OSErr GetFilenameFromPathname(ConstStr255Param pathname, Str255 filename); /* ¶ Get the object name from the end of a full or partial pathname. The GetFilenameFromPathname function gets the file (or directory) name from the end of a full or partial pathname. Returns notAFileErr if the pathname is nil, the pathname is empty, or the pathname cannot refer to a filename (with a noErr result, the pathname could still refer to a directory). pathname input: A full or partial pathname. filename output: The file (or directory) name. __________ See also: GetObjectLocation. */ /*****************************************************************************/ pascal OSErr GetObjectLocation(short vRefNum, long dirID, StringPtr pathname, short *realVRefNum, long *realParID, Str255 realName, Boolean *isDirectory); /* ¶ Get a file system object's location. The GetObjectLocation function gets a file system object's location - that is, its real volume reference number, real parent directory ID, and name. While we're at it, determine if the object is a file or directory. If GetObjectLocation returns fnfErr, then the location information returned is valid, but it describes an object that doesn't exist. You can use the location information for another operation, such as creating a file or directory. vRefNum input: Volume specification. dirID input: Directory ID. pathname input: Pointer to object name, or nil when dirID specifies a directory that's the object. realVRefNum output: The real volume reference number. realParID output: The parent directory ID of the specified object. realName output: The name of the specified object (the case of the object name may not be the same as the object's catalog entry on disk - since the Macintosh file system is not case sensitive, it shouldn't matter). isDirectory output: True if object is a directory; false if object is a file. __________ See also: FSMakeFSSpecCompat */ /*****************************************************************************/ pascal OSErr GetDirItems(short vRefNum, long dirID, StringPtr name, Boolean getFiles, Boolean getDirectories, FSSpecPtr items, short reqItemCount, short *actItemCount, short *itemIndex); /* ¶ Return a list of items in a directory. The GetDirItems function returns a list of items in the specified directory in an array of FSSpec records. File, subdirectories, or both can be returned in the list. vRefNum input: Volume specification. dirID input: Directory ID. name input: Pointer to object name, or nil when dirID specifies a directory that's the object. getFiles input: Pass true to have files added to the items list. getDirectories input: Pass true to have directories added to the items list. items input: Pointer to array of FSSpec where the item list is returned. reqItemCount input: Maximum number of items to return (the number of elements in the items array). actItemCount output: The number of items actually returned. itemIndex input: The current item index position. Set to 1 to start with the first item in the directory. output: The item index position to get the next item. Pass this value the next time you call GetDirItems to start where you left off. */ /*****************************************************************************/ pascal OSErr DeleteDirectoryContents(short vRefNum, long dirID, StringPtr name); /* ¶ Delete the contents of a directory. The DeleteDirectoryContents function deletes the contents of a directory. All files and subdirectories in the specified directory are deleted. If a locked file or directory is encountered, it is unlocked and then deleted. If any unexpected errors are encountered, DeleteDirectoryContents quits and returns to the caller. vRefNum input: Volume specification. dirID input: Directory ID. name input: Pointer to directory name, or nil when dirID specifies a directory that's the object. __________ Also see: DeleteDirectory */ /*****************************************************************************/ pascal OSErr DeleteDirectory(short vRefNum, long dirID, StringPtr name); /* ¶ Delete a directory and its contents. The DeleteDirectory function deletes a directory and its contents. All files and subdirectories in the specified directory are deleted. If a locked file or directory is encountered, it is unlocked and then deleted. After deleting the directories contents, the directory is deleted. If any unexpected errors are encountered, DeleteDirectory quits and returns to the caller. vRefNum input: Volume specification. dirID input: Directory ID. name input: Pointer to directory name, or nil when dirID specifies a directory that's the object. __________ Also see: DeleteDirectoryContents */ /*****************************************************************************/ pascal OSErr CheckObjectLock(short vRefNum, long dirID, StringPtr name); /* ¶ Determine if a file or directory is locked. The CheckObjectLock function determines if a file or directory is locked. If CheckObjectLock returns noErr, then the file or directory is not locked. vRefNum input: Volume specification. dirID input: Directory ID. name input: Pointer to object name, or nil when dirID specifies a directory that's the object. __________ Also see: FSpCheckObjectLock */ /*****************************************************************************/ pascal OSErr FSpCheckObjectLock(const FSSpec *spec); /* ¶ Determine if a file or directory is locked. The FSpCheckObjectLock function determines if a file or directory is locked. If FSpCheckObjectLock returns noErr, then the file or directory is not locked. spec input: An FSSpec record specifying the object. __________ Also see: CheckObjectLock */ /*****************************************************************************/ pascal OSErr GetFileSize(short vRefNum, long dirID, ConstStr255Param fileName, long *dataSize, long *rsrcSize); /* ¶ Get the logical sizes of a file's forks. The GetFileSize function returns the logical size of a file's data and resource fork. vRefNum input: Volume specification. dirID input: Directory ID. name input: The name of the file. dataSize output: The number of bytes in the file's data fork. rsrcSize output: The number of bytes in the file's resource fork. __________ See also: FSpGetFileSize */ /*****************************************************************************/ pascal OSErr FSpGetFileSize(const FSSpec *spec, long *dataSize, long *rsrcSize); /* ¶ Get the logical sizes of a file's forks. The FSpGetFileSize function returns the logical size of a file's data and resource fork. spec input: An FSSpec record specifying the file. dataSize output: The number of bytes in the file's data fork. rsrcSize output: The number of bytes in the file's resource fork. __________ See also: GetFileSize */ /*****************************************************************************/ pascal OSErr BumpDate(short vRefNum, long dirID, StringPtr name); /* ¶ Update the modification date of a file or directory. The BumpDate function changes the modification date of a file or directory to the current date/time. If the modification date is already equal to the current date/time, then add one second to the modification date. vRefNum input: Volume specification. dirID input: Directory ID. name input: Pointer to object name, or nil when dirID specifies a directory that's the object. __________ See also: FSpBumpDate */ /*****************************************************************************/ pascal OSErr FSpBumpDate(const FSSpec *spec); /* ¶ Update the modification date of a file or directory. The FSpBumpDate function changes the modification date of a file or directory to the current date/time. If the modification date is already equal to the current date/time, then add one second to the modification date. spec input: An FSSpec record specifying the object. __________ See also: BumpDate */ /*****************************************************************************/ pascal OSErr ChangeCreatorType(short vRefNum, long dirID, ConstStr255Param name, OSType creator, OSType fileType); /* ¶ Change the creator or file type of a file. The ChangeCreatorType function changes the creator or file type of a file. vRefNum input: Volume specification. dirID input: Directory ID. name input: The name of the file. creator input: The new creator type or 0x00000000 to leave the creator type alone. fileType input: The new file type or 0x00000000 to leave the file type alone. __________ See also: FSpChangeCreatorType */ /*****************************************************************************/ pascal OSErr FSpChangeCreatorType(const FSSpec *spec, OSType creator, OSType fileType); /* ¶ Change the creator or file type of a file. The FSpChangeCreatorType function changes the creator or file type of a file. spec input: An FSSpec record specifying the file. creator input: The new creator type or 0x00000000 to leave the creator type alone. fileType input: The new file type or 0x00000000 to leave the file type alone. __________ See also: ChangeCreatorType */ /*****************************************************************************/ pascal OSErr ChangeFDFlags(short vRefNum, long dirID, StringPtr name, Boolean setBits, unsigned short flagBits); /* ¶ Set or clear Finder Flag bits. The ChangeFDFlags function sets or clears Finder Flag bits in the fdFlags field of a file or directory's FInfo record. vRefNum input: Volume specification. dirID input: Directory ID. name input: Pointer to object name, or nil when dirID specifies a directory that's the object. setBits input: If true, then set the bits specified in flagBits. If false, then clear the bits specified in flagBits. flagBits input: The flagBits parameter specifies which Finder Flag bits to set or clear. If a bit in flagBits is set, then the same bit in fdFlags is either set or cleared depending on the state of the setBits parameter. __________ See also: FSpChangeFDFlags */ /*****************************************************************************/ pascal OSErr FSpChangeFDFlags(const FSSpec *spec, Boolean setBits, unsigned short flagBits); /* ¶ Set or clear Finder Flag bits. The FSpChangeFDFlags function sets or clears Finder Flag bits in the fdFlags field of a file or directory's FInfo record. spec input: An FSSpec record specifying the object. setBits input: If true, then set the bits specified in flagBits. If false, then clear the bits specified in flagBits. flagBits input: The flagBits parameter specifies which Finder Flag bits to set or clear. If a bit in flagBits is set, then the same bit in fdFlags is either set or cleared depending on the state of the setBits parameter. __________ See also: ChangeFDFlags */ /*****************************************************************************/ pascal OSErr SetIsInvisible(short vRefNum, long dirID, StringPtr name); /* ¶ Set the invisible Finder Flag bit. The SetIsInvisible function sets the invisible bit in the fdFlags word of the specified file or directory's finder information. vRefNum input: Volume specification. dirID input: Directory ID. name input: Pointer to object name, or nil when dirID specifies a directory that's the object. __________ See also: FSpSetIsInvisible, ClearIsInvisible, FSpClearIsInvisible */ /*****************************************************************************/ pascal OSErr FSpSetIsInvisible(const FSSpec *spec); /* ¶ Set the invisible Finder Flag bit. The FSpSetIsInvisible function sets the invisible bit in the fdFlags word of the specified file or directory's finder information. spec input: An FSSpec record specifying the object. __________ See also: SetIsInvisible, ClearIsInvisible, FSpClearIsInvisible */ /*****************************************************************************/ pascal OSErr ClearIsInvisible(short vRefNum, long dirID, StringPtr name); /* ¶ Clear the invisible Finder Flag bit. The ClearIsInvisible function clears the invisible bit in the fdFlags word of the specified file or directory's finder information. vRefNum input: Volume specification. dirID input: Directory ID. name input: Pointer to object name, or nil when dirID specifies a directory that's the object. __________ See also: SetIsInvisible, FSpSetIsInvisible, FSpClearIsInvisible */ /*****************************************************************************/ pascal OSErr FSpClearIsInvisible(const FSSpec *spec); /* ¶ Clear the invisible Finder Flag bit. The FSpClearIsInvisible function clears the invisible bit in the fdFlags word of the specified file or directory's finder information. spec input: An FSSpec record specifying the object. __________ See also: SetIsInvisible, FSpSetIsInvisible, ClearIsInvisible */ /*****************************************************************************/ pascal OSErr SetNameLocked(short vRefNum, long dirID, StringPtr name); /* ¶ Set the nameLocked Finder Flag bit. The SetNameLocked function sets the nameLocked bit in the fdFlags word of the specified file or directory's finder information. vRefNum input: Volume specification. dirID input: Directory ID. name input: Pointer to object name, or nil when dirID specifies a directory that's the object. __________ See also: FSpSetNameLocked, ClearNameLocked, FSpClearNameLocked */ /*****************************************************************************/ pascal OSErr FSpSetNameLocked(const FSSpec *spec); /* ¶ Set the nameLocked Finder Flag bit. The FSpSetNameLocked function sets the nameLocked bit in the fdFlags word of the specified file or directory's finder information. spec input: An FSSpec record specifying the object. __________ See also: SetNameLocked, ClearNameLocked, FSpClearNameLocked */ /*****************************************************************************/ pascal OSErr ClearNameLocked(short vRefNum, long dirID, StringPtr name); /* ¶ Clear the nameLocked Finder Flag bit. The ClearNameLocked function clears the nameLocked bit in the fdFlags word of the specified file or directory's finder information. vRefNum input: Volume specification. dirID input: Directory ID. name input: Pointer to object name, or nil when dirID specifies a directory that's the object. __________ See also: SetNameLocked, FSpSetNameLocked, FSpClearNameLocked */ /*****************************************************************************/ pascal OSErr FSpClearNameLocked(const FSSpec *spec); /* ¶ Clear the nameLocked Finder Flag bit. The FSpClearNameLocked function clears the nameLocked bit in the fdFlags word of the specified file or directory's finder information. spec input: An FSSpec record specifying the object. __________ See also: SetNameLocked, FSpSetNameLocked, ClearNameLocked */ /*****************************************************************************/ pascal OSErr SetIsStationery(short vRefNum, long dirID, ConstStr255Param name); /* ¶ Set the isStationery Finder Flag bit. The SetIsStationery function sets the isStationery bit in the fdFlags word of the specified file or directory's finder information. vRefNum input: Volume specification. dirID input: Directory ID. name input: Pointer to object name, or nil when dirID specifies a directory that's the object. __________ See also: FSpSetIsStationery, ClearIsStationery, FSpClearIsStationery */ /*****************************************************************************/ pascal OSErr FSpSetIsStationery(const FSSpec *spec); /* ¶ Set the isStationery Finder Flag bit. The FSpSetIsStationery function sets the isStationery bit in the fdFlags word of the specified file or directory's finder information. spec input: An FSSpec record specifying the object. __________ See also: SetIsStationery, ClearIsStationery, FSpClearIsStationery */ /*****************************************************************************/ pascal OSErr ClearIsStationery(short vRefNum, long dirID, ConstStr255Param name); /* ¶ Clear the isStationery Finder Flag bit. The ClearIsStationery function clears the isStationery bit in the fdFlags word of the specified file or directory's finder information. vRefNum input: Volume specification. dirID input: Directory ID. name input: Pointer to object name, or nil when dirID specifies a directory that's the object. __________ See also: SetIsStationery, FSpSetIsStationery, FSpClearIsStationery */ /*****************************************************************************/ pascal OSErr FSpClearIsStationery(const FSSpec *spec); /* ¶ Clear the isStationery Finder Flag bit. The FSpClearIsStationery function clears the isStationery bit in the fdFlags word of the specified file or directory's finder information. spec input: An FSSpec record specifying the object. __________ See also: SetIsStationery, FSpSetIsStationery, ClearIsStationery */ /*****************************************************************************/ pascal OSErr SetHasCustomIcon(short vRefNum, long dirID, StringPtr name); /* ¶ Set the hasCustomIcon Finder Flag bit. The SetHasCustomIcon function sets the hasCustomIcon bit in the fdFlags word of the specified file or directory's finder information. vRefNum input: Volume specification. dirID input: Directory ID. name input: Pointer to object name, or nil when dirID specifies a directory that's the object. __________ See also: FSpSetHasCustomIcon, ClearHasCustomIcon, FSpClearHasCustomIcon */ /*****************************************************************************/ pascal OSErr FSpSetHasCustomIcon(const FSSpec *spec); /* ¶ Set the hasCustomIcon Finder Flag bit. The FSpSetHasCustomIcon function sets the hasCustomIcon bit in the fdFlags word of the specified file or directory's finder information. spec input: An FSSpec record specifying the object. __________ See also: SetHasCustomIcon, ClearHasCustomIcon, FSpClearHasCustomIcon */ /*****************************************************************************/ pascal OSErr ClearHasCustomIcon(short vRefNum, long dirID, StringPtr name); /* ¶ Clear the hasCustomIcon Finder Flag bit. The ClearHasCustomIcon function clears the hasCustomIcon bit in the fdFlags word of the specified file or directory's finder information. vRefNum input: Volume specification. dirID input: Directory ID. name input: Pointer to object name, or nil when dirID specifies a directory that's the object. __________ See also: SetHasCustomIcon, FSpSetHasCustomIcon, FSpClearHasCustomIcon */ /*****************************************************************************/ pascal OSErr FSpClearHasCustomIcon(const FSSpec *spec); /* ¶ Clear the hasCustomIcon Finder Flag bit. The FSpClearHasCustomIcon function clears the hasCustomIcon bit in the fdFlags word of the specified file or directory's finder information. spec input: An FSSpec record specifying the object. __________ See also: SetHasCustomIcon, FSpSetHasCustomIcon, ClearHasCustomIcon */ /*****************************************************************************/ pascal OSErr ClearHasBeenInited(short vRefNum, long dirID, StringPtr name); /* ¶ Clear the hasBeenInited Finder Flag bit. The ClearHasBeenInited function clears the hasBeenInited bit in the fdFlags word of the specified file or directory's finder information. vRefNum input: Volume specification. dirID input: Directory ID. name input: Pointer to object name, or nil when dirID specifies a directory that's the object. __________ See also: FSpClearHasBeenInited */ /*****************************************************************************/ pascal OSErr FSpClearHasBeenInited(const FSSpec *spec); /* ¶ Clear the hasBeenInited Finder Flag bit. The FSpClearHasBeenInited function clears the hasBeenInited bit in the fdFlags word of the specified file or directory's finder information. spec input: An FSSpec record specifying the object. __________ See also: ClearHasBeenInited */ /*****************************************************************************/ pascal OSErr CopyFileMgrAttributes(short srcVRefNum, long srcDirID, StringPtr srcName, short dstVRefNum, long dstDirID, StringPtr dstName, Boolean copyLockBit); /* ¶ Copy all File Manager attributes from the source to the destination. The CopyFileMgrAttributes function copies all File Manager attributes from the source file or directory to the destination file or directory. If copyLockBit is true, then set the locked state of the destination to match the source. srcVRefNum input: Source volume specification. srcDirID input: Source directory ID. srcName input: Pointer to source object name, or nil when srcDirID specifies a directory that's the object. dstVRefNum input: Destination volume specification. dstDirID input: Destination directory ID. dstName input: Pointer to destination object name, or nil when dstDirID specifies a directory that's the object. copyLockBit input: If true, set the locked state of the destination to match the source. __________ See also: FSpCopyFileMgrAttributes */ /*****************************************************************************/ pascal OSErr FSpCopyFileMgrAttributes(const FSSpec *srcSpec, const FSSpec *dstSpec, Boolean copyLockBit); /* ¶ Copy all File Manager attributes from the source to the destination. The FSpCopyFileMgrAttributes function copies all File Manager attributes from the source file or directory to the destination file or directory. If copyLockBit is true, then set the locked state of the destination to match the source. srcSpec input: An FSSpec record specifying the source object. dstSpec input: An FSSpec record specifying the destination object. copyLockBit input: If true, set the locked state of the destination to match the source. __________ See also: CopyFileMgrAttributes */ /*****************************************************************************/ pascal OSErr HOpenAware(short vRefNum, long dirID, ConstStr255Param fileName, short denyModes, short *refNum); /* ¶ Open the data fork of a file using deny mode permissions. The HOpenAware function opens the data fork of a file using deny mode permissions instead the normal File Manager permissions. If OpenDeny is not available, then HOpenAware translates the deny modes to the closest File Manager permissions and tries to open the file with OpenDF first, and then Open if OpenDF isn't available. By using HOpenAware with deny mode permissions, a program can be "AppleShare aware" and fall back on the standard File Manager open calls automatically. vRefNum input: Volume specification. dirID input: Directory ID. fileName input: The name of the file. denyModes input: The deny modes access under which to open the file. refNum output: The file reference number of the opened file. __________ See also: FSpOpenAware, HOpenRFAware, FSpOpenRFAware */ /*****************************************************************************/ pascal OSErr FSpOpenAware(const FSSpec *spec, short denyModes, short *refNum); /* ¶ Open the data fork of a file using deny mode permissions. The FSpOpenAware function opens the data fork of a file using deny mode permissions instead the normal File Manager permissions. If OpenDeny is not available, then FSpOpenAware translates the deny modes to the closest File Manager permissions and tries to open the file with OpenDF first, and then Open if OpenDF isn't available. By using FSpOpenAware with deny mode permissions, a program can be "AppleShare aware" and fall back on the standard File Manager open calls automatically. spec input: An FSSpec record specifying the file. denyModes input: The deny modes access under which to open the file. refNum output: The file reference number of the opened file. __________ See also: HOpenAware, HOpenRFAware, FSpOpenRFAware */ /*****************************************************************************/ pascal OSErr HOpenRFAware(short vRefNum, long dirID, ConstStr255Param fileName, short denyModes, short *refNum); /* ¶ Open the resource fork of a file using deny mode permissions. The HOpenRFAware function opens the resource fork of a file using deny mode permissions instead the normal File Manager permissions. If OpenRFDeny is not available, then HOpenRFAware translates the deny modes to the closest File Manager permissions and tries to open the file with OpenRF. By using HOpenRFAware with deny mode permissions, a program can be "AppleShare aware" and fall back on the standard File Manager open calls automatically. vRefNum input: Volume specification. dirID input: Directory ID. fileName input: The name of the file. denyModes input: The deny modes access under which to open the file. refNum output: The file reference number of the opened file. __________ See also: HOpenAware, FSpOpenAware, FSpOpenRFAware */ /*****************************************************************************/ pascal OSErr FSpOpenRFAware(const FSSpec *spec, short denyModes, short *refNum); /* ¶ Open the resource fork of a file using deny mode permissions. The FSpOpenRFAware function opens the resource fork of a file using deny mode permissions instead the normal File Manager permissions. If OpenRFDeny is not available, then FSpOpenRFAware translates the deny modes to the closest File Manager permissions and tries to open the file with OpenRF. By using FSpOpenRFAware with deny mode permissions, a program can be "AppleShare aware" and fall back on the standard File Manager open calls automatically. spec input: An FSSpec record specifying the file. denyModes input: The deny modes access under which to open the file. refNum output: The file reference number of the opened file. __________ See also: HOpenAware, FSpOpenAware, HOpenRFAware */ /*****************************************************************************/ pascal OSErr FSReadNoCache(short refNum, long *count, void *buffPtr); /* ¶ Read any number of bytes from an open file requesting no caching. The FSReadNoCache function reads any number of bytes from an open file while asking the file system to bypass its cache mechanism. refNum input: The file reference number of an open file. count input: The number of bytes to read. output: The number of bytes actually read. buffPtr input: A pointer to the data buffer into which the bytes are to be read. __________ See also: FSWriteNoCache */ /*****************************************************************************/ pascal OSErr FSWriteNoCache(short refNum, long *count, const void *buffPtr); /* ¶ Write any number of bytes to an open file requesting no caching. The FSReadNoCache function writes any number of bytes to an open file while asking the file system to bypass its cache mechanism. refNum input: The file reference number of an open file. count input: The number of bytes to write to the file. output: The number of bytes actually written. buffPtr input: A pointer to the data buffer from which the bytes are to be written. __________ See also: FSReadNoCache */ /*****************************************************************************/ pascal OSErr FSWriteVerify(short refNum, long *count, const void *buffPtr); /* ¶ Write any number of bytes to an open file and then verify the data was written. The FSWriteVerify function writes any number of bytes to an open file and then verifies that the data was actually written to the device. refNum input: The file reference number of an open file. count input: The number of bytes to write to the file. output: The number of bytes actually written and verified. buffPtr input: A pointer to the data buffer from which the bytes are to be written. */ /*****************************************************************************/ pascal OSErr CopyFork(short srcRefNum, short dstRefNum, void *copyBufferPtr, long copyBufferSize); /* ¶ Copy all data from the source fork to the destination fork of open file forks. The CopyFork function copies all data from the source fork to the destination fork of open file forks and makes sure the destination EOF is equal to the source EOF. srcRefNum input: The source file reference number. dstRefNum input: The destination file reference number. copyBufferPtr input: Pointer to buffer to use during copy. The buffer should be at least 512-bytes minimum. The larger the buffer, the faster the copy. copyBufferSize input: The size of the copy buffer. */ /*****************************************************************************/ pascal OSErr GetFileLocation(short refNum, short *vRefNum, long *dirID, StringPtr fileName); /* ¶ Get the location of an open file. The GetFileLocation function gets the location (volume reference number, directory ID, and fileName) of an open file. refNum input: The file reference number of an open file. vRefNum output: The volume reference number. dirID output: The parent directory ID. fileName input: Points to a buffer (minimum Str63) where the filename is to be returned or must be nil. output: The filename. __________ See also: FSpGetFileLocation */ /*****************************************************************************/ pascal OSErr FSpGetFileLocation(short refNum, FSSpec *spec); /* ¶ Get the location of an open file in an FSSpec record. The FSpGetFileLocation function gets the location of an open file in an FSSpec record. refNum input: The file reference number of an open file. spec output: FSSpec record containing the file name and location. __________ See also: GetFileLocation */ /*****************************************************************************/ pascal OSErr CopyDirectoryAccess(short srcVRefNum, long srcDirID, StringPtr srcName, short dstVRefNum, long dstDirID, StringPtr dstName); /* ¶ Copy the AFP directory access privileges. The CopyDirectoryAccess function copies the AFP directory access privileges from one directory to another. Both directories must be on the same file server, but not necessarily on the same server volume. srcVRefNum input: Source volume specification. srcDirID input: Source directory ID. srcName input: Pointer to source directory name, or nil when srcDirID specifies the directory. dstVRefNum input: Destination volume specification. dstDirID input: Destination directory ID. dstName input: Pointer to destination directory name, or nil when dstDirID specifies the directory. __________ See also: FSpCopyDirectoryAccess */ /*****************************************************************************/ pascal OSErr FSpCopyDirectoryAccess(const FSSpec *srcSpec, const FSSpec *dstSpec); /* ¶ Copy the AFP directory access privileges. The FSpCopyDirectoryAccess function copies the AFP directory access privileges from one directory to another. Both directories must be on the same file server, but not necessarily on the same server volume. srcSpec input: An FSSpec record specifying the source directory. dstSpec input: An FSSpec record specifying the destination directory. __________ See also: CopyDirectoryAccess */ /*****************************************************************************/ pascal OSErr HMoveRenameCompat(short vRefNum, long srcDirID, ConstStr255Param srcName, long dstDirID, StringPtr dstpathName, StringPtr copyName); /* ¶ Move a file or directory and optionally rename it. The HMoveRenameCompat function moves a file or directory and optionally renames it. The source and destination locations must be on the same volume. This routine works even if the volume doesn't support MoveRename. vRefNum input: Volume specification. srcDirID input: Source directory ID. srcName input: The source object name. dstDirID input: Destination directory ID. dstName input: Pointer to destination directory name, or nil when dstDirID specifies a directory. copyName input: Points to the new name if the object is to be renamed or nil if the object isn't to be renamed. __________ See also: FSpMoveRenameCompat */ /*****************************************************************************/ pascal OSErr FSpMoveRenameCompat(const FSSpec *srcSpec, const FSSpec *dstSpec, StringPtr copyName); /* ¶ Move a file or directory and optionally rename it. The FSpMoveRenameCompat function moves a file or directory and optionally renames it. The source and destination locations must be on the same volume. This routine works even if the volume doesn't support MoveRename. srcSpec input: An FSSpec record specifying the source object. dstSpec input: An FSSpec record specifying the destination directory. copyName input: Points to the new name if the object is to be renamed or nil if the object isn't to be renamed. __________ See also: HMoveRenameCompat */ /*****************************************************************************/ pascal void BuildAFPVolMountInfo(short theFlags, char theNBPInterval, char theNBPCount, short theUAMType, Str31 theZoneName, Str31 theServerName, Str27 theVolName, Str31 theUserName, Str8 theUserPassWord, Str8 theVolPassWord, MyAFPVolMountInfoPtr theAFPInfo); /* ¶ Initialize the fields of an AFPVolMountInfo record. The BuildAFPVolMountInfo function initializes the fields of an AFPVolMountInfo record for use before using that record to call the VolumeMount function. theFlags input: The AFP mounting flags. 0 = normal mount; set bit 0 to inhibit greeting messages. theNBPInterval input: The interval used for VolumeMount's NBP Lookup call. 7 is a good choice. theNBPCount input: The retry count used for VolumeMount's NBP Lookup call. 5 is a good choice. theUAMType input: The user authentication method to use. theZoneName input: The AppleTalk zone name of the server. theServerName input: The AFP server name. theVolName input: The AFP volume name. theUserName input: The user name (zero length Pascal string for guest). theUserPassWord input: The user password (zero length Pascal string if no user password) theVolPassWord input: The volume password (zero length Pascal string if no volume password) theAFPInfo input: Pointer to AFPVolMountInfo record to initialize. __________ Also see: GetVolMountInfoSize, GetVolMountInfo, VolumeMount, RetrieveAFPVolMountInfo */ /*****************************************************************************/ pascal OSErr RetrieveAFPVolMountInfo(AFPVolMountInfoPtr theAFPInfo, short *theFlags, short *theUAMType, StringPtr theZoneName, StringPtr theServerName, StringPtr theVolName, StringPtr theUserName); /* ¶ Retrieve the AFP mounting information from an AFPVolMountInfo record. The RetrieveAFPVolMountInfo function retrieves the AFP mounting information returned in an AFPVolMountInfo record by the GetVolMountInfo function. theAFPInfo input: Pointer to AFPVolMountInfo record that contains the AFP mounting information. theFlags output: The AFP mounting flags. 0 = normal mount; if bit 0 is set, greeting meesages were inhibited. theUAMType output: The user authentication method used. theZoneName output: The AppleTalk zone name of the server. theServerName output: The AFP server name. theVolName output: The AFP volume name. theUserName output: The user name (zero length Pascal string for guest). __________ Also see: GetVolMountInfoSize, GetVolMountInfo, VolumeMount, BuildAFPVolMountInfo */ /*****************************************************************************/ pascal OSErr GetUGEntries(short objType, UGEntryPtr entries, long reqEntryCount, long *actEntryCount, long *objID); /* ¶ Retrieve a list of user or group entries from the local file server. The GetUGEntries functions retrieves a list of user or group entries fromthe local file server. objType input: The object type: -1 = group; 0 = user UGEntries input: Pointer to array of UGEntry records where the list is returned. reqEntryCount input: The number of elements in the UGEntries array. actEntryCount output: The number of entries returned. objID input: The current index position. Set to 0 to start with the first entry. output: The index position to get the next entry. Pass this value the next time you call GetUGEntries to start where you left off. __________ Also see: GetUGEntry */ /*****************************************************************************/ #endif /* __MOREFILESEXTRAS__ */